Cerberus [CONFIGURE] options
This section provides an overview of current [CONFIGURE] options. These are divided into three categories:
- Public
- Optimization
- Diagnostic
Optimization and Diagnostic options are included for reference purposes only and should only be used under the direction of Alterian Support or Development staff. Private settings should not be used as they may lead to serious system instability.
Public category settings
AggregateRealWidth
|
Description |
Sets a specific width for aggregate columns which are of data type Real. |
[VALUE] |
Minimum value 0, Maximum value 1023. |
Default |
15 |
AggregateBigIntWidth
|
Description |
Sets a specific width for aggregate columns which are of data type BigInt. |
[VALUE] |
Minimum value 0, Maximum value 1023. |
Default |
20 |
BackupDir
|
Description |
The root folder in which table backups are stored. |
[VALUE] |
String value indicating the root folder in which to store table backups. |
Default |
None |
CerlogFileSizeThresholdMB
|
Description |
Cerberus INI configuration setting to control the growth of the Cerlog allowing definition of an integer value indicating the number of megabytes (MB) the cerlog can grow to before Engine attempts to rename it and start a new file. If set to a non-zero value Engine will allow the cerlog to grow to the specified number of megabytes before attempting to rename it. At the point the size of the cerlog reaches the threshold Engine will flush pending log entries and rename the file using the file creation date to create a new name. The creation date is the UTC file time and should line-up closely with the first entries in the log file. |
[VALUE] |
Integer indicating the size in megabytes (MB). |
Default |
0 |
ChangeAggregateZeroToNull
|
Description |
Used in Query resolution to determine whether a null is counted as 0 or null when the aggregate is used in a query (eg, resolve IS NULL to EQ 0d). |
[VALUE] |
- 0 : Any nulls in an aggregate will be counted as null when the aggregate is used in a query.
- <> 0 : Any nulls in an aggregate will be counted as 0 when the aggregate is used in a query.
|
Default |
False |
CheckFile
|
Description |
Sets the location of the @check@ file used by Engine to monitor the status of the repository. |
[VALUE] |
String value indicating the folder in which to store the file. |
Default |
By default the @check@ file is stored in the root of the active repository. |
Remarks |
To be used with databases stored on read-only media (such as CD or DVD) where it is not possible for Engine to write the @check@ file to the repository root. Requires a restart of Engine.
Note: If CheckFile points to an invalid location, Engine will not be able to start up.
|
Example |
CheckFile=c:\MyData
|
CommaNumbers
|
Description |
If non-zero, decimal points (.) will be displayed as commas (,).
|
[VALUE] |
|
Default |
0 |
Remarks |
If ON, decimals will be replaced by commas when retrieving results from a Crosstab or when retrieving data from a recordset. Requires a restart of Engine.
|
DefaultCentury
|
Description |
Date formats of DDMMYY will use this value for CC. |
[VALUE] |
20 will set default e.g. 2016; 19 will set default e.g. 1916.
|
Default |
20 |
DefaultPrecision
|
Description |
The default precision to be used when calculating real numbers in expressions or when loading column data. |
[VALUE] |
|
Default |
2 |
Remarks |
DefaultPrecision affects the creation and calculation of REAL Fields, whether as part of a data load process via iLoader, or through creation of dynamic fields as part of data engineering.
Loading Data
When loading data unless otherwise specified, real data will be loaded with a precision of DefaultPrecision:
- Raw Data X.XXXX (precision = 4)
- Loaded Data: X.XX (precision = 2)
However, it is possible to explicitly set the precision prior to the load via
- the iLoader PRECISION keyword,
- or by specifying the precision in the iLoader TABLE_DEFINITION|FORMAT parameter.
If the precision has been explicitly set using one of these methods, it overrides the DefaultPrecision setting, when set to 3:
- Raw Data X.X (precision = 1)
- Loaded Data: X.XXX (precision = 3)
Precision settings truncate (by rounding up), or extend (by adding zeros) as appropriate.
Creating Expressions
When creating expressions, the precision of the resulting REAL field is determined by the parameters in the expression. The highest precision in the expression is used to determine the resulting precision. For example, when set to 2:
- Expression A.AAA B.B
- Loaded Data: X.XXX (precision = 3)
When calculating expressions, the precision can be explicitly set by use of the REAL keyword: REAL([EXPRESSION], [PRECISION])
|
DelimitedOutputCharacter
|
Description |
Default delimited output character. |
[VALUE] |
See below. |
Default |
\t |
Remarks |
The delimiter can be specified in one of three ways:
- Character Literals: Single character entries such as ",", "|" and "!" (without the quotes) will be interpreted literally.
- Escape Characters: The following double character entries are taken as special characters: "\t" - Tab;
"\n" - Line Feed;
"\r" - Character Return;
"\v" - Vertical tab;
"\f" - Form Feed
"; \0" - Null Terminator.
-
Character Code: A character code can be specified in either decimal or hex. A hex code must be prefixed by 0x i.e.
-
DelimitedOutputCharacter=0x003e
-
If a unicode character with a high byte set is used on a ansi text dump only the lower byte of the delimiter will be used. Care must be taken with this.
|
DelimitedOutputEnabled
|
Description |
Output text dumps to fixed width format by default. |
[VALUE] |
<>False: Output text dumps to a fixed width format by default. |
Default |
False |
Remarks |
If set to False, all text dumps will be in fixed width format, no matter what the specified delimiter is.
If set to True, the system uses the 'DelimitedOutputCharacter' setting to determine which delimiter character will be used.
|
DistanceDivisor
|
Description |
The co-ordinance scaling factor to use when converting data in the X-COORDINATE and Y-COORDINATE columns to the scale required for mapping applications. |
[VALUE] |
Scaling factor. |
Default |
1.000000 |
Remarks |
Data in the specified X and Y columns (see XPlot and YPlot for further details) may not be at the same scale as that required by a mapping application.
For example, when doing a point plot of data, the mapping application may require data to be in meters. However, the X and Y coordinates may be stored in the Engine database in units of 10 meters.
If no scaling factor was used and the X and Y coordinates were used by the mapping application in their stored form, it is likely that any points which are plotted will be in the wrong location on the map - typically if this happens it looks to the user as if nothing has been plotted on the map when in reality all the data is being plotted somewhere off the edges of the map.
The default value of 10 assumes that data stored in the EASTING and NORTHING columns is in 10s of meters. If it was stored in Kilometers, a DistanceDivisor of 1000 would be required.
The default value is 10 because this is the format of the data shipped with the default database.
|
EnhancedSecurity
|
Description |
Enables Enhanced security. |
[VALUE] |
- 0: Enhanced Security is OFF.
- 1: Enhanced security is ON.
|
Default |
1 |
Remarks |
Requires restart of Engine.
|
ExpressionBigIntWidth
|
Description |
Sets a specific width for expression columns which are of data type BigInt. |
[VALUE] |
Minimum value 0, Maximum value 1023. |
Default |
20 |
ExpressionDateWidth
|
Description |
Sets a specific width for expression columns which are of data type Date. |
[VALUE] |
Minimum value 0, Maximum value 1023. |
Default |
20 |
ExpressionIntegerWidth
|
Description |
Sets a specific width for expression columns which are of data type Integer. |
[VALUE] |
Minimum value 0, Maximum value 1023. |
Default |
20 |
ExpressionNullWidth
|
Description |
Sets a specific width for expression columns which contain NULLs. |
[VALUE] |
Minimum value 0, Maximum value 1023. |
Default |
20 |
ForceRecalcToday
|
Description |
When set to 'True' all expressions using _TODAY will be recalculated automatically. |
[VALUE] |
0: Expressions using _TODAY will not be recalculated automatically
<>0: Expressions using _TODAY will be recalculated automatically
|
Default |
0 |
ImportBufferSizeMB
|
Description |
The size of the buffer (in MB) to use when importing data from file. |
[VALUE] |
Min = 1
Max = 65535
|
Default |
256 |
LocalLinks
|
Description |
By default, all link files are stored in the repository folder. By setting LocalLinks to non-zero, whenever both link keys come from the same database, the link files will be stored in the database folder. |
[VALUE] |
- 0: Links will be stored in the repository folder.
- 1<>0: Where link keys both come from the same database, link files will be stored in the Database folder.
|
Default |
0 |
Remarks |
Requires restart of Engine. This can be of use when using Windows file copying to copy Engine databases or transfer database from one repository to another, as any internal links within the database are also copied.
If LocalLinks is not used and data is copied in this way, it will be necessary to rebuild the internal Database links in the copied data.
|
LogLocalTimeZone
|
Description |
Controls the time setting is used when outputting messages to the log files. |
[VALUE] |
- 0 : GMT is used as the standard time for logging.
- <>0 : local system time is used for logging.
|
Default |
1 |
MemoTextLimit
|
Description |
Rescans a database directory for new tables. |
[VALUE] |
- 0: Do not rescan the database on start up.
- <>0: Rescan database.
|
Default |
0 |
Remarks |
Can be used to resync a database in the event of a failed load.
|
RoundImportedReals
|
Description |
Rounds REALs imported from text to the field precision. |
[VALUE] |
- 0 : Off - no rounding will take place.
- <>0 : REALs will be rounded to the precision set by the CO_DefaultPrecision setting.
|
Default |
1 |
SelectIntoIncludesURN
|
Description |
If ON, a SELECT INTO clause will add IURNS to the new table. |
[VALUE] |
|
Default |
0 |
Remarks |
The SELECT INTO syntax is used to output data to a file or table. When outputting to a table, it is possible to automatically include the Engine IURN of the selected records by setting SelectIntoIncludesURN to ON.
|
Example |
SELECT Field1, Field2
INTO [DB].[NEWTABLE]
WHERE Field1="A";
If SelectIntoIncludesURN is ON, the resulting table will contain 3 fields, the first of which will be a field called URN containing the internal record numbers:
|
SetAggregateNullToZero
|
Description |
Nulls in aggregates stored as zero. |
[VALUE] |
- 0: Nulls in aggregates are not stored as zero.
- <>0: Nulls in aggregates are stored as zeros.
|
Default |
0 |
Remarks |
In some cases it may be valid to store nulls as zeros. However, this will usually be invalid - for example, consider a situation where you are summing customer profitability by Household. One household may have no customers i.e. null, which would be stored as zero if this setting was switched on. Another household may have two customers with profitability value of +5 and -5 respectively which would be summed to 0. In this scenario a null and a 0 value would be very different.
|
SharedImportLog
|
Description |
Share one import log file between multiple tables. |
[VALUE] |
- 0 : Each table will have its own import error log.
- <>0 : All tables will share the same import error log.
|
Default |
0 |
SheetUseGlobalDateFormat
|
Description |
If not zero, Sheet views of Date columns are displayed using the global system date format. |
[VALUE] |
- 0 : Use UO_DateFormat.
- <>0 : Use SO_SystemDate Format.
|
Default |
0 |
UseParallelImporterIndexing
|
Description |
Attempt to run multiple index jobs in parallel from importer. |
[VALUE] |
- 0 : Multiple index jobs will not be run in parallel.
- <>0 : Multiple index jobs will be run in parallel.
|
Default |
1 |
Optimization
Member |
Description |
Opt_CarouselScanThreshold
|
% of column values requested for stream sharing to occur.
|
Opt_ContractionGainThreshold
|
Gain threshold of text expression compression.
|
Opt_ContractionWidthThreshold
|
Minimum width for text expression compression.
|
Opt_ExpressionBlockSizeMultiplier
|
Number of 8k expression blocks to evaluate per pass.
|
Opt_InplaceUpdateRowThreshold
|
Number of rows in an update file, below which an inplace update will be attempted by default.
|
Opt_MaximumMemoryUsageOnImportMB
|
Amount of memory to use on import defaults to -1 which is half physical ram.
|
Opt_MaxSingleAllocationBlockSizeMB
|
Maximum single ram allocation block in Mb
|
Opt_RemapBufferCount
|
Count of buffers for 1D crosstabulations.
|
Opt_SecurityFilterCacheLimit
|
Maximum number of table filter domains to cache for any given security filter.
|
Opt_StorageUnloadTimeoutSec
|
Number of idle seconds before a storage is considered for unloading.
|
Opt_UniqueListBuildBufferSize
|
Tokens per block building UniqueList DAT files.
|
Opt_WorkingSetMb
|
Maximum size of the working set.
|
Opt_XTabBufferCount
|
Count of buffers for 2D crosstabulations.
|
Diagnostic
Member |
Description |
Dgn_AppendRecordsForceReindex
|
0 if the indexes should be reused (if possible) 1 if they should be rebuilt 2 to validate the reusing (slow).
|
Dgn_ArchiveFailedLinkData
|
Archive failed link data files (0=no action 1=dump to folder).
|
Dgn_DeleteOnExit
|
Cleanup unreleased deleted objects at shutdown.
|
Dgn_DeleteRecordsForceReindex
|
0 if the indexes should be reused (if possible) 1 if they should be rebuilt 2 to validate the reusing (slow).
|
Dgn_DiagnoseFileLocks
|
Enables process identification when a file lock violation occurs.
|
Dgn_DiagnosticLevel
|
Diagnostic level for testing.
|
Dgn_DisableProxyColumns
|
Disable creation and use of proxy view columns.
|
Dgn_ExtendedErrors
|
Log contains additional error info.
|
Dgn_ExternalDiscreteLockBuffer
|
Causes external discrete processing to lock memory (if it has the right) to prevent paging.
|
Dgn_FlushDisconnect
|
Disconnect Com Objects on flush.
|
Dgn_ForceNoIndexOptimisedLinking
|
Disable index optimized linking.
|
Dgn_IgnoreGenericBitmapAcceleration
|
|
Dgn_OptimiseDiscreteSort
|
Bypasses low cardinality sort file generation under certain conditions.
|
Dgn_QueryInfo
|
If non zero extended query info is written to the log.
|
Dgn_QueryLog
|
Log for all SQL queries.
|
Dgn_ResourceLogging
|
Track resource usage.
|
Dgn_TrackApi
|
Log chosen API events
|
Dgn_TrackFileInfo
|
Write file I/O info to files.csv.
|
Dgn_Tracking
|
1 = resolveindex; 2 = bandinfo; 4 = NSQL resolve; 8 = Compression; 16 = LinkConversion; 32 = Decompress; 64 = Indexing.
|
Dgn_UseThreadsForBitmapOperations
|
Logical operations on bitmap segments executed in parallel.
|
Dgn_ValidateDiscreteSortIndex
|
Validate srt/srx discrete sort indexes.
|
Dgn_ValidateIndexes
|
Validate the generic indexes after creation this will be slow.
|
|
|